From: Matthias Clasen <mclasen@redhat.com>
Date: Mon, 6 Jun 2022 12:55:51 +0000 (-0400)
Subject: gdk: Improve GdkTimeCoord docs
X-Git-Tag: archive/raspbian/4.8.3+ds-2+rpi1~3^2~81^2^2~141^2
X-Git-Url: https://dgit.raspbian.org/%22http://www.example.com/cgi/%22/%22http:/www.example.com/cgi/%22?a=commitdiff_plain;h=c76069389c8e83af665be676712ef29cb344ddcc;p=gtk4.git

gdk: Improve GdkTimeCoord docs
---

diff --git a/gdk/gdkdevice.h b/gdk/gdkdevice.h
index cf329499a4..c24c084631 100644
--- a/gdk/gdkdevice.h
+++ b/gdk/gdkdevice.h
@@ -66,10 +66,15 @@ typedef enum
 /**
  * GdkTimeCoord:
  * @time: The timestamp for this event
- * @flags: Flags indicating what axes are present
- * @axes: (array fixed-size=12): axis values
+ * @flags: Flags indicating what axes are present, see [flags@Gdk.AxisFlags]
+ * @axes: (array fixed-size=12): axis values, indexed by [enum@Gdk.AxisUse]
  *
  * A `GdkTimeCoord` stores a single event in a motion history.
+ *
+ * To check whether an axis is present, check whether the corresponding
+ * flag from the [flags@Gdk.AxisFlags] enumeration is set in the @flags
+ * To access individual axis values, use the values of the values of
+ * the [enum@Gdk.AxisUse] enumerations as indices.
  */
 struct _GdkTimeCoord
 {